home *** CD-ROM | disk | FTP | other *** search
/ SuperHack / SuperHack CD.bin / CODING / C / THESRC20.ZIP / OS2.HLP < prev    next >
Encoding:
Text File  |  1995-01-27  |  19.9 KB  |  551 lines
  1. /***********************************************************************/
  2. /* (os2)             Help file for The Hessling Editor            2.0  */
  3. /***********************************************************************/
  4.  
  5.  Command-line invocation:
  6.  
  7.  the [-h?nmrs] [-p profile] [-a profile_arg] [-w width] [[dir] [file [...]]]
  8.  
  9.   Where:
  10.     -h or -?      Display usage information and version.
  11.     -n            Do not execute a profile file.
  12.     -m            Force display into mono, ignoring colour support.
  13.     -r            Run THE in read-only mode.
  14.     -s            A debugging aid for Unix versions. Turns off signal trapping.
  15.     -p profile    The name of the profile file to use.  If not specified,
  16.                   the file "PROFILE.THE" will be used, unless overridden
  17.                   by the environment variable "THE".
  18.     -a prof-arg   Used to pass a string to the profile file as argument.
  19.                   Only works with REXX macros.
  20.     -w width      Length of longest line THE can handle (default 2048)
  21.     dir           Will display a directory of the specified dir.
  22.     file [..]     Specifications of file(s) to edit.  If multiple files
  23.                   are specified, each will be put in a separate file in
  24.                   the ring.  The first one specified will be displayed.
  25.                   If no files are specified, the current directory will
  26.                   be displayed.
  27.                   Issuing [SOS EDIT] on a file spec will edit that file.
  28.                   [SOS EDIT] on a subdir will display that directory.
  29.  
  30.     Option flags must be specified in LOWER case.
  31.  
  32.  
  33.  Environment variables used:
  34.  --------------------------
  35.  See Appendix 1 of the.man
  36.  
  37.  Notes:
  38.   - The capitalised portion of a command is the minimum abbreviation
  39.     for the command.
  40.   - UP, DOWN, NEXT differ from XEDIT and Kedit in that they do not
  41.     accept numerical arguments abutted to the command name.
  42.     Thus "N3" is not supported.
  43.  
  44.  
  45.  THE Commands:
  46.  -------------
  47.  
  48.  Add [n]
  49.        add blank line
  50.  ALL [rtarget]
  51.        select and display restricted set of lines
  52.  BAckward [n|*]
  53.        scroll backwards [n] screens
  54.  BOTtom
  55.        move to the bottom of the file
  56.  CANcel
  57.        quit from all unaltered files in the ring
  58.  CCancel
  59.        qquit from all files in the ring
  60.  Change /string1/string2/ [target] [n] [m]
  61.        change one string to another
  62.  cmatch
  63.        find matching bracket character
  64.  CMSG [text]
  65.        display text on command line
  66.  COMMAND command [options]
  67.        execute a command without translation
  68.  control_char
  69.        allow control characters to be entered
  70.  COPY target1 target2
  71.  COPY BLOCK [RESET]
  72.        copies text from one position to another
  73.  CURsor Screen UP|DOWN|LEFT|RIGHT
  74.  CURsor Screen row [col]
  75.  CURsor [Escreen] UP|DOWN
  76.  CURsor [Escreen|Kedit] LEFT|RIGHT
  77.  CURsor [Escreen] row [col]
  78.  CURsor CMdline [n]
  79.  CURsor HOME [SAVE]
  80.        move cursor to specified position
  81.  DEFine key-name [command [args] [[#command [args]...]]]
  82.        assign one or many commands to a key
  83.  DELete [target]
  84.        delete lines from a file
  85.  DIRectory [filespec]
  86.        list the specified directory as an editable file
  87.  DOS [command]
  88.        execute an operating system command
  89.  DOSNowait command
  90.        execute an operating system command - no prompt
  91.  DOSQuiet command
  92.        execute an operating system command quietly
  93.  Down [relative_target]
  94.        move forward in the file a number of lines
  95.  DUPlicate [n [target|BLOCK]]
  96.        duplicate lines
  97.  Edit [filename]
  98.        edit another file or switch to next file
  99.  EMSG [message]
  100.        display message
  101.  enter
  102.        execute a command
  103.  EXPand [target]
  104.        expand tab characters to spaces
  105.  EXTract /item/[...]
  106.        obtain various internal information about THE
  107.  FFile  [filename]
  108.        force a FILE of the current file to disk
  109.  FILE  [filename]
  110.        write the current file to disk and remove from ring
  111.  FILLbox [c]
  112.        fill the marked box block with a character
  113.  FOrward [n]
  114.        scroll forwards [n] screens
  115.  GET [fileid]
  116.        insert into file the contents of specified file
  117.  HELP
  118.        edit help file for THE
  119.  Input [line contents]
  120.        insert the command line contents into the file
  121.  Join [ALigned]
  122.        join a line with the line following
  123.  LEft [n|HALF]
  124.        scroll the screen to the left
  125.  [Locate] target [command]
  126.        search for a target
  127.  LOWercase [target]
  128.        change uppercase characters to lowercase
  129.  LS [filespec]
  130.        list the specified directory as an editable file
  131.  MACRO filename [arguments]
  132.        execute a macro command file
  133.  MARK Line|Box|Stream|Word|Column
  134.        mark a portion of text
  135.  MODify set-command
  136.        display current SET command for alteration
  137.  MOVE BLOCK [RESET]
  138.        move a portion of text
  139.  MSG [message]
  140.        display message on error line
  141.  Next [relative_target]
  142.        move forward in the file a number of lines
  143.  NEXTWindow
  144.        switch focus of editing session to other window
  145.  NOMSG command [parameters]
  146.        execute a command suppressing any messages
  147.  NOP
  148.        no operation command
  149.  OS [command]
  150.        execute an operating system command
  151.  OSNowait command
  152.        execute an operating system command - no prompt
  153.  OSQuiet command
  154.        execute an operating system command quietly
  155.  OVERLAYBox
  156.        overlay marked box block on current cursor position
  157.  PRint [target] [n]
  158.  PRint LINE [text]
  159.  PRint STRING [text]
  160.  PRint FORMfeed
  161.  PRint CLOSE
  162.        send text to default printer or print spooler
  163.  PUT [target] [fileid]
  164.        write part of a file to another
  165.  PUTD [target] [fileid]
  166.        write part of a file to another and delete
  167.  QQuit
  168.        exit from the current file without saving changes
  169.  Query item
  170.        display various option settings
  171.  QUIT
  172.        exit from the current file if no changes made
  173.  READV Cmdline|KEY
  174.        read keystrokes and pass to macro
  175.  RECover [n|*]
  176.        recover changed or deleted lines
  177.  REDRAW
  178.        redraw the current screen
  179.  REFRESH
  180.        refresh the contents of the current screen
  181.  REPEat [target]
  182.        repeat the last command
  183.  Replace [text]
  184.        replace the current line with supplied text
  185.  RESet ALL|Block|Prefix
  186.        cancel the marked block or prefix commands or both
  187.  RGTLEFT [n]
  188.        scroll the screen to the left or right
  189.  RIght [n|HALF]
  190.        scroll the screen to the right
  191.  SAVE [fileid]
  192.        save changes to current file
  193.  SCHange /string1/string2/ [target] [n] [m]
  194.        selectively change strings
  195.  SET set_command [set_command parameter(s) ...]
  196.        execute various set commands
  197.  SHift Left|Right [n] [target]
  198.        move text left or right
  199.  SHOWKey
  200.        display current key value and command assignation
  201.  SORT target [[[Ascending|Descending] left_col right_col] [...]]
  202.        sort selected lines in a file
  203.  SOS sos_command [sos_command ...]
  204.        execute various sos commands
  205.  SPlit [ALigned]
  206.        split a line into two lines
  207.  spltjoin
  208.        split/join two lines
  209.  SSave [fileid]
  210.        force SAVE to specified file
  211.  STATus [filename]
  212.        display current settings of various variables
  213.  SUSPend
  214.        suspend THE and return to operating system
  215.  tabpre
  216.        switch between FILEAREA and PREFIX area
  217.  TEXT text
  218.        simulate keyboard entry of characters
  219.  THE [filename]
  220.        edit another file or switch to next file
  221.  TOP
  222.        move to the top of the file
  223.  Up [relative_target]
  224.        move backward in the file a number of lines
  225.  UPPercase [target]
  226.        change lowercase characters to uppercase
  227.  Xedit [filename]
  228.        edit another file or switch to next file
  229.  ?[+]
  230.        return the next/prior command on the command line
  231.  =
  232.        re-execute the last command issued on the command line
  233.  ! [command]
  234.        execute an operating system command
  235.  
  236.  SET commands
  237.  ------------
  238.  
  239.  [SET] ARBchar ON|OFF [char1] [char2]
  240.        set arbitrary character(s) for targets
  241.  [SET] AUtosave n|OFF
  242.        set autosave period
  243.  [SET] BACKup OFF|TEMP|KEEP|ON
  244.        indicate if a backup copy of the file is to be kept
  245.  [SET] BEEP ON|OFF
  246.        turn on or off the audible alarm when displaying errors
  247.  [SET] CASE Mixed|Lower|Upper [Respect|Ignore] [Respect|Ignore]
  248.  [Respect|Ignore]
  249.        set case sensitivity parameters
  250.  [SET] CLEARScreen ON|OFF
  251.        indicate if the screen is to be cleared on exit
  252.  [SET] CLOCK ON|OFF
  253.        turn on or off display of time on status line
  254.  [SET] CMDArrows Retrieve|Tab
  255.        sets the behaviour of the up and down arrow keys
  256.  [SET] CMDline ON|OFF|Top|Bottom
  257.        sets the position of the command line.
  258.  [SET] COLOUR area [modifier[...]] [foreground background]
  259.  [SET] COLOR  area [modifier[...]] [foreground background]
  260.        set colours for display
  261.  [SET] COMPat The|Xedit|Kedit
  262.        set compatibility mode
  263.  [SET] CURLine M[+n|-n] | [+|-]n
  264.        set position of current line on screen
  265.  [SET] DIRInclude *
  266.  [SET] DIRInclude [Normal] [Readonly] [System] [Hidden] [Directory]
  267.        set the file mask for directory command
  268.  [SET] DISPlay n [m|*]
  269.        specify which level of lines to display
  270.  [SET] EOLout CRLF|LF
  271.        set end of line terminating character(s)
  272.  [SET] ETMODE ON|OFF
  273.        indicate if extended display mode is possible
  274.  [SET] HEX ON|OFF
  275.        set how hexidecimal strings are treated in string operands
  276.  [SET] HEXDISPlay ON|OFF
  277.        turn on or off display of character under cursor
  278.  [SET] HEXShow ON|OFF [M[+n|-n]|[+|-]n]
  279.        turn on or off hex display of current line
  280.  [SET] IDline ON|OFF
  281.        specify if IDLINE is displayed
  282.  [SET] IMPcmscp ON|OFF
  283.        set implied operating system command processing
  284.  [SET] IMPMACro ON|OFF
  285.        set implied macro command processing
  286.  [SET] IMPOS ON|OFF
  287.        set implied operating system command processing
  288.  [SET] INSERTMode ON|OFF|TOGGLE
  289.        put editor into or out of insert mode
  290.  [SET] LINENd ON|OFF [char]
  291.        allow/disallow multiple commands on command line
  292.  [SET] MACROExt [ext]
  293.        set default macro extension value
  294.  [SET] MACROPath path[s]
  295.        set default path for macro commands
  296.  [SET] MARgins left right [[+|-]indent]
  297.        set left and right margins for wordwrap
  298.  [SET] MSGLine ON [M[+n|-n]|[+|-]n] [lines]
  299.        set position and size of message line
  300.  [SET] MSGMode ON|OFF
  301.        set display of messages on or off
  302.  [SET] NEWLines Aligned|Left
  303.        set position of cursor after adding blank line
  304.  [SET] NONDisp char
  305.        specify character to display for non-displaying characters
  306.  [SET] NUMber ON|OFF
  307.        turn prefix numbers on or off
  308.  [SET] PENDing ON string
  309.  [SET] PENDing OFF
  310.  [SET] PENDing BLOCK string
  311.        set status of pending prefix commands
  312.  [SET] Point .name [OFF]
  313.        assign a name to the current line
  314.  [SET] POSition ON|OFF
  315.        determine if LINE/COL is displayed on IDLINE
  316.  [SET] PREfix ON [Left|Right]
  317.  [SET] PREfix Nulls [Left|Right]
  318.  [SET] PREfix OFF
  319.  [SET] PREfix Synonym newname oldname
  320.        set prefix area attributes
  321.  [SET] PRINTER spooler
  322.        define printer spooler name
  323.  [SET] REPROFile ON|OFF
  324.        indicate if profile file to be executed for all files
  325.  [SET] RESERved +|-n [colour] text|OFF
  326.        display a reserved line
  327.  [SET] REXXOUTput File|Display n
  328.        indicate where REXX output is to go
  329.  [SET] SCALE ON|OFF [M[+n|-n]|[+|-]n]
  330.        set position and status of scale line on screen
  331.  [SET] SCOPE All|Display
  332.        sets which lines are to be excluded from commands
  333.  [SET] SCReen n [Horizontal|Vertical]
  334.        specifiy number of screens displayed
  335.  [SET] SELect [+|-]n [target]
  336.        sets the selection level for the specified lines
  337.  [SET] SHADOW ON|OFF
  338.        determines if shadow lines are displayed or not
  339.  [SET] STATUSLine Top|Bottom|Off|GUI
  340.        set position of status line
  341.  [SET] STAY ON|OFF
  342.        set condition of cursor position after CHANGE/LOCATE commands
  343.  [SET] SYNonym ON|OFF
  344.  [SET] SYNonym [LINEND char] newname [n] oldname
  345.        define synonyms for commands
  346.  [SET] TABKey Tab|Character Tab|Character
  347.        set characteristics of the SOS TABF command
  348.  [SET] TABLine ON|OFF [M[+n|-n]|[+|-]n]
  349.        set position and status of tab line on screen
  350.  [SET] TABS n1 n2[n3...n32]
  351.  [SET] TABS INCR n
  352.        set tab length for TAB key
  353.  [SET] TABSIn ON|OFF [n]
  354.        set tab processing on file input
  355.  [SET] TABSOut ON|OFF [n]
  356.        set tab processing on file output
  357.  [SET] TYPEAhead ON|OFF
  358.        set behavior of screen redraw
  359.  [SET] Verify first [last]
  360.        set column display limits
  361.  [SET] WORDWrap ON|OFF
  362.        set wordwrap feature on or off
  363.  [SET] Zone first [last]
  364.        set column limits for editing
  365.  
  366.  SOS commands
  367.  ------------
  368.  
  369.  SOS ADDline
  370.        add blank line after focus line
  371.  SOS BOTTOMEdge
  372.        move cursor to bottom edge of FILEAREA
  373.  SOS CURRent
  374.        move cursor to current line
  375.  SOS CURSORAdj
  376.        move first non-blank character to cursor
  377.  SOS DELBAck
  378.        delete the character to the left of the cursor
  379.  SOS DELChar
  380.        delete character under cursor
  381.  SOS DELEnd
  382.        delete to end of line
  383.  SOS DELLine
  384.        delete focus line
  385.  SOS DELWord
  386.        delete word at or right of cursor
  387.  SOS DOPREfix
  388.        execute any pending prefix commands
  389.  SOS EDIT
  390.        edit a file from directory list
  391.  SOS ENDChar
  392.        move cursor to end of focus line
  393.  SOS EXecute
  394.        move cursor to command line and execute command
  395.  SOS FIRSTCHar
  396.        move cursor to first non-blank of field
  397.  SOS FIRSTCOl
  398.        move cursor to first column of field
  399.  SOS LASTCOl
  400.        move cursor to last column of field
  401.  SOS LEFTEdge
  402.        move cursor to left edge of window
  403.  SOS LINEAdd
  404.        add blank line after focus line
  405.  SOS LINEDel
  406.        delete focus line
  407.  SOS MAKECURR
  408.        make focus line the current line
  409.  SOS MARGINL
  410.        move cursor to the left margin column
  411.  SOS MARGINR
  412.        move cursor to the right margin column
  413.  SOS PARINDent
  414.        move cursor to the paragraph indent column
  415.  SOS PREfix
  416.        move cursor to leftmost edge of prefix area
  417.  SOS QCmnd
  418.        move cursor to command line and clear
  419.  SOS RIGHTEdge
  420.        move cursor to right edge of window
  421.  SOS STARTENDChar
  422.        move cursor to end/start of focus line
  423.  SOS TABB
  424.        move cursor to previous tab stop
  425.  SOS TABf
  426.        move cursor to next tab stop
  427.  SOS TABFIELDB
  428.        move cursor to previous enterable field
  429.  SOS TABFIELDf
  430.        move cursor to next enterable field
  431.  SOS TABWORDB
  432.        move cursor to beginning of previous word
  433.  SOS TABWORDf
  434.        move cursor to start of next word
  435.  SOS TOPEdge
  436.        move cursor to top edge of filearea
  437.  SOS UNDO
  438.        undo changes to the current line
  439.  
  440.  THE prefix commands:
  441.  -------------------
  442.  a      - add blank line
  443.  i
  444.  /      - make line current line
  445.  c      - copy line
  446.  m      - move line
  447.  d      - delete line
  448.  x      - exclude line
  449.  "      - duplicate line
  450.  s      - show excluded lines
  451.  p      - target for c and m - prior to line
  452.  f      - target for c and m - following line
  453.  >      - shift line right
  454.  <      - shift line left
  455.  cc     - copy line block
  456.  mm     - move line block
  457.  dd     - delete line block
  458.  xx     - exclude line block
  459.  ""     - duplicate line block
  460.  >>     - shift line block right
  461.  <<     - shift line block left
  462.  .xxxxx - give name to line
  463.  TABL   - display tab line
  464.  SCALE  - display scale line
  465.  
  466.  
  467.  THE Line Targets:
  468.  ----------------
  469.  Absolute target:        An absolute line number.
  470.                          eg. :12 - line number 12
  471.  All target:             All lines in file the file.
  472.                          eg. ALL
  473.  Blank target:           The first line containing only blank characters.
  474.                          eg. BLANK
  475.  Block target:           All lines in the marked block.
  476.                          eg. BLOCK
  477.  Named line target:      A line with a name, set with [SET] POINT
  478.                          eg. .fred
  479.  Relative target:        A target relative to the current line.
  480.                          eg. 12 - 12 lines below the current line
  481.                              -4 - 4 lines above the current line
  482.                              *  - all lines below the current line
  483.                              -* - all lines above the current line
  484.  String target:          A sequence of characters between delimiters.
  485.                          eg. /string/  - the first line below the
  486.                                          current line containing "string"
  487.                              -/string/ - the first line above the
  488.                                          current line containing "string"
  489.  
  490.  Targets may be separated by the boolean operators '&' or '|'.
  491.  eg.  /string1/ | /string2/
  492.  Targets may also be prefixed with '~' to signify boolean NOT.
  493.  eg.  ~/string/
  494.  
  495.  Default Key Assignments:
  496.  ------------------------
  497.  The first column is the name of the key in its normal state. Shifted
  498.  keys have a 'S-' prefix, control keys have a 'C-' prefix and Alt keys
  499.  have a 'A-' prefix. Thus key names for F1 are: F1,S-F1,C-F1 and A-F1.
  500.  The key names are the same as displayed by the showkeys command.
  501.  
  502.  ---------+-------------------+-----------+--------------+-------------
  503.  Key Name | Normal            | Shifted   | Control      | Alt
  504.  ---------+-------------------+-----------+--------------+-------------
  505.  F1       | help              | locate    |              |
  506.  F2       | nextwindow        |           |              |
  507.  F3       | file              | qquit     |              |
  508.  F4       | sos addline 1     |           |              |
  509.  F5       | sos makecurr      |           |              |
  510.  F6       |                   |           |              |
  511.  F7       | cmatch            |           |              |
  512.  F8       | recover           |           |              |
  513.  F9       | sos delline 1     |           |              |
  514.  F10      | spltjoin          |           |              |
  515.  F11      |                   |           | point .a     |
  516.  F12      | control_char      |           | locate .a    |
  517.  CURU     | cursor left       |           |              |
  518.  CURD     | cursor down       |           |              |
  519.  CURL     | cursor left       |           | sos tabwordb |
  520.  CURR     | cursor right      |           | sos tabwordf |
  521.  INS      | insertmode toggle |           |              |
  522.  DEL      | sos delchar       |           |              |
  523.  HOME     | cursor home save  |           |              |
  524.  END      | sos startendchar  |           | sos delend   |
  525.  PGUP     | backward 1        |           | top          |
  526.  PGDN     | forward 1         |           | forward *    |
  527.  BKSP     | sos delback       |           |              |
  528.  ENTER    | enter             |           |              |
  529.  PLUS     | tabpre            |           |              |
  530.  NUMENTER | sos doprefix      |           |              |
  531.  ESC      | sos undo          |           |              |
  532.  TAB      | sos tabf          | sos tabb  |              |
  533.  A        |                   |           | sos cursoradj| 
  534.  B        |                   |           |              | mark box
  535.  C        |                   |           |              | copy block reset
  536.  D        |                   |           |              | duplicate 1 block
  537.  F        |                   |           |              | fillbox
  538.  G        |                   |           |              | delete block
  539.  J        |                   |           |              | join aligned
  540.  K        |                   |           |              | copy block
  541.  L        |                   |           |              | mark line
  542.  M        |                   |           |              | move block reset
  543.  O        |                   |           |              | overlaybox
  544.  R        |                   |           | redraw       |
  545.  S        |                   |           |              | split aligned
  546.  U        |                   |           |              | reset block
  547.  W        |                   |           |              | sos delword
  548.  X        |                   |           |              | sos edit
  549.  Z        |                   |           | suspend      |
  550.  ---------+-------------------+-----------+--------------+-------------
  551.